/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 ****************************************************************/
package org.epiphron;

import org.semanticweb.owlapi.model.OWLOntology;

/**
 * Basic interface for semantic validators of beans.
 * This class is a main entry point for Sever library
 */
public interface SemanticValidator {
	/**
	 * Validates a given set of objects with a given
	 * "schema" model, and returns report with errors and/or warnings
	 * @param level level of validation
	 * @param model "schema" ontology that defines semantic constraints
	 * @param beans set of objects that will be validated for 
	 * semantic rules observance
	 * @return report with errors and/or warnings
	 */
	public ValidityReport validate(ValidationLevel level, OWLOntology ontology, Object... beans) throws EpiphronException;
	
	/**
	 * Validates a given set of objects with a given
	 * "schema" model, and returns report with errors and/or warnings
	 * By default, use strongest level of validation
	 * @param model "schema" ontology that defines semantic constraints
	 * @param beans set of objects that will be validated for 
	 * semantic rules observance
	 * @return report with errors and/or warnings
	 */
	public ValidityReport validate(OWLOntology ontology, Object... beans) throws EpiphronException;
	
	/**
	 * Validates a given set of objects with a given
	 * "schema" model, and returns report with errors and/or warnings.
	 * Also performs inferring on given objects
	 * @param model "schema" ontology that defines semantic constraints
	 * @param beans set of objects that will be validated for 
	 * semantic rules observance
	 * @return report with errors and/or warnings
	 */
	public ValidityReport validateAndInfer(OWLOntology ontology, Object... beans) throws EpiphronException;
}
